/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.web.portlet.bean.impl;

import org.springframework.util.StringUtils;

import com.genia.toolbox.basics.exception.BundledException;
import com.genia.toolbox.web.portlet.visitor.PortletVisitor;

/**
 * Portlet that mimics the comportment of another porlet identified by its
 * spring name.
 */
public class LinkedPortlet
    extends AbstractLinkedPortlet
{

  /**
   * the spring name of the linked portlet.
   */
  private String linkedPortletName;



  /**
   * getter for the linkedPortletName property.
   * 
   * @return the linkedPortletName
   */
  @Override
  public String getLinkedPortletName()
  {
    return linkedPortletName;
  }



  /**
   * setter for the linkedPortletName property.
   * 
   * @param linkedPortletName
   *          the linkedPortletName to set
   */
  public void setLinkedPortletName(final String linkedPortletName)
  {
    this.linkedPortletName = StringUtils.trimWhitespace(linkedPortletName);
  }



  /**
   * The visit method to use with a <code>PortletVisitor</code>.
   * 
   * @param visitor
   *          the <code>PortletVisitor</code>
   * @throws BundledException
   *           when an error occurred.
   * @see com.genia.toolbox.web.portlet.bean.Portlet#visit(com.genia.toolbox.web.portlet.visitor.PortletVisitor)
   */
  public void visit(final PortletVisitor visitor)
      throws BundledException
  {
    visitor.visitLinkedPortlet(this);
  }

}
